package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.UserRoleCompanyAddDTO;
import org.jsola.hr.dto.UserRoleCompanyBatchDTO;
import org.jsola.hr.dto.UserRoleCompanyUpdateDTO;
import org.jsola.hr.query.UserRoleCompanyQuery;
import org.jsola.hr.vo.UserRoleCompanyListVO;
import org.jsola.hr.vo.UserRoleCompanyVO;

import java.util.List;

/**
 * 人员分管用工单位
 *
 * @author zhr
 */
@Api(tags = "hr-人员分管用工单位")
public interface IUserRoleCompanyControllerAPI {

    /**
     * 新增人员分管用工单位
     * @param userRoleCompanyAddDTO 人员分管用工单位新增实体
     * @return 人员分管用工单位展示对象
     */
    @ApiOperation(value = "新增人员分管用工单位")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userRoleCompanyAddDTO", dataType = "UserRoleCompanyAddDTO", value = "新增人员分管用工单位", paramType = "body")
    })
    Result<UserRoleCompanyVO> save(UserRoleCompanyAddDTO userRoleCompanyAddDTO);


    /**
     * 修改人员分管用工单位
     * @param userRoleCompanyUpdateDTO 人员分管用工单位
     * @return 更新数量
     */
    @ApiOperation(value = "修改人员分管用工单位")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userRoleCompanyUpdateDTO", dataType = "UserRoleCompanyUpdateDTO", value = "修改人员分管用工单位", paramType = "body")
    })
    Result<Integer> update(UserRoleCompanyUpdateDTO userRoleCompanyUpdateDTO);

    /**
     * 批量编辑、新增、删除人员分管用工单位
     * @param userRoleCompanyBatchDTO 要操作的人员分管用工单位
     * @return 操作之后的全部人员分管用工单位
     */
    @ApiOperation(value = "批量编辑、新增、删除人员分管用工单位")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userRoleCompanyBatchDTO", dataType = "UserRoleCompanyBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(UserRoleCompanyBatchDTO userRoleCompanyBatchDTO);



    /**
     * 删除单个人员分管用工单位，彻底删除
     * @param userRoleCompanyId 人员分管用工单位id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个人员分管用工单位，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userRoleCompanyId", dataType = "String", value = "人员分管用工单位id", paramType = "path")
    })
    Result<Integer> delete(String userRoleCompanyId);


    /**
     * 批量删除人员分管用工单位，彻底删除
     * @param userRoleCompanyIds 人员分管用工单位id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除人员分管用工单位，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userRoleCompanyIds", dataType = "String[]", value = "人员分管用工单位id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] userRoleCompanyIds);


    /**
     * 根据人员分管用工单位id查询人员分管用工单位详情
     * @param userRoleCompanyId 人员分管用工单位id
     * @return 人员分管用工单位详情
     */
    @ApiOperation(value="根据人员分管用工单位id查询人员分管用工单位详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userRoleCompanyId", dataType = "String", value = "人员分管用工单位id", paramType = "path")
    })
    Result<UserRoleCompanyVO> findById(String userRoleCompanyId);


    /**
     * 查询人员分管用工单位
     * @param userRoleCompanyQuery 人员分管用工单位查询参数
     * @return page
     */
    @ApiOperation(value="查询人员分管用工单位")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userRoleCompanyQuery", dataType = "UserRoleCompanyQuery", value = "人员分管用工单位查询参数", paramType = "query")
    })
    Result<List<UserRoleCompanyListVO>> listAll(UserRoleCompanyQuery userRoleCompanyQuery);


     /**
     * 分页查询人员分管用工单位
     * @param userRoleCompanyQuery 人员分管用工单位查询参数
     * @return page
     */
    @ApiOperation(value="分页查询人员分管用工单位")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userRoleCompanyQuery", dataType = "UserRoleCompanyQuery", value = "人员分管用工单位查询参数", paramType = "query")
    })
    Result<Page<UserRoleCompanyListVO>> page(UserRoleCompanyQuery userRoleCompanyQuery);


}

